Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

auto-generate list of Units and AreaUnits and link all modules with units param #2694

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

twelch
Copy link
Collaborator

@twelch twelch commented Aug 9, 2024

Resolves #1298
Builds on #2683

ToDo

  • auto-generate list of Units and AreaUnits (Need to figure out how to structure the queries properly, help welcome)
  • insert into turf-helpers/README.md as part of generate-readmes.ts
  • migrate all modules with units parameters to link to this README. Make sure the functions actually support all units.

Feedback is welcome on approach of using the tsquery module to query and build a master list of supported Units and AreaUnits, as part of the generate-readmes.ts script run by CI. tsquery is a relatively easy-to-use AST/query tool that is different from the AST that documentation.js produces, which I think using Babel. I think this will be easier to maintain.

@twelch twelch changed the title auto-generate list of Units and AreaUnits and link auto-generate list of Units and AreaUnits and link all modules with units param Aug 9, 2024
@@ -33,6 +33,7 @@
"@monorepolint/config": "0.5.0-alpha.132",
"@monorepolint/core": "0.5.0-alpha.132",
"@monorepolint/rules": "0.5.0-alpha.132",
"@phenomnomnominal/tsquery": "6.1.3",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ts-morph would be the alternative library here if you decide you don't like tsquery, I don't have a strong opinion here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Supporting "meters" unit
2 participants